Consolidate readmes and contribution guidelines #4281
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It duplicates the general readme
github-actions
bot
added
Needs tech review
aneta-petrova
commented
Sep 19, 2025
| * [ ] I fill out the cherry-picking list in the PR template to the best of my abilities to signify which versions my update applies to. | ||
| If unsure, I let reviewers know so that they can assist. | ||
|
|
||
| ## Foreman documentation minimalist style guide |
There was a problem hiding this comment.
Potential reviewers: Note that all these style conventions have been moved from another document. I didn't write them and I'd like to avoid tweaking how they are worded 🙃 If anyone would like to see the wording improved, I'd suggest doing it in another PR. Thanks for understanding!
However, as noted in the PR description, I'd be happy to remove lines that are obsolete or redundant.
|
The PR preview for 8d63fbc is available at theforeman-foreman-documentation-preview-pr-4281.surge.sh No diff compared to the current base |
This was
linked to
issues
Sep 19, 2025
Co-authored-by: Maximilian Kolb <[email protected]>
aneta-petrova
force-pushed
the
contributing
branch
from
cef0b72 to
8d63fbc
Compare
aneta-petrova
removed
Needs tech review
maximiliankolb
approved these changes
Sep 22, 2025
maximiliankolb
removed
the
Needs style review
maximiliankolb
added
the
style review done
This was referenced Sep 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes are you introducing?
This PR looks at the existing readmes and contribution documents and attempts to make it easier to navigate through them. As a result, there are now:
One new thing that I'm adding is an explanation for the CP checklist in the PR template, to address #3219
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
To better separate types of information: readmes are for how to work with the repo; contributing is for how to contribute; style guide is for Foreman documentation conventions.
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Hopefully the next step would be to review the style guide part to remove redundant information and duplicates. I found a few but I haven't really focused on that yet so if you spot something that could be dropped, I'd be happy to do so.
Contributor checklists
Please cherry-pick my commits into:
Review checklists
Tech review (performed by an Engineer who did not author the PR; can be skipped if tech review is unnecessary):
Style review (by a Technical Writer who did not author the PR):